查询基础信息

获取如下基本信息:

  • 电量信息:剩余电量、预计可用时长;
  • 联网信息:WiFi名称、IP地址;
  • 存储信息:总容量、剩余容量;
  • 当前状态:在线状态(上次离线时间/本次上线时间)、离线状态(上次上线时间/上次离线时间)。

请求地址

GET {{url}}/robot-state/query

请求参数

参数名称 参数类型 默认值 是否必须 参数描述
serialNum String 机器人序列号

响应参数 返回的JSON数据

参数名称 参数类型 参数描述
code Integer 状态码
message String 信息
data Object 数据对象

data的结构

参数名称 参数类型 参数描述
batteryInfo Object 电量信息
networkInfo Object 联网信息
storageInfo Object 存储信息
onlineInfo Object 当前状态

batteryInfo的结构

参数名称 参数类型 参数描述
electricitySurplus String 电量剩余
estimatedAvailableTime String 预计可用(单位:s,返回已带单位)

networkInfo的结构

参数名称 参数类型 参数描述
wifiName String WiFi名称
ip String IP地址

storageInfo

参数名称 参数类型 参数描述
totalSpace String 总容量(单位:G,保留2位小数,返回已带单位)
freeSpace String 剩余容量(单位:G,保留2位小数,返回已带单位)

onlineInfo

参数名称 参数类型 参数描述
onlineTime String 本次上线时间(格式:yyyy-MM-dd HH:mm:ss)
lastOfflineTime String 上次离线时间(格式:yyyy-MM-dd HH:mm:ss)
lastOnlineTime String 上次在线时间(格式:yyyy-MM-dd HH:mm:ss)
state Integer 当前状态:0-离线;1-在线

请求示例

GET {{url}}/robot-state/query?serialNum=Cruzr.01.b0f1ecccb123

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "batteryInfo": {
            "electricitySurplus": "95%",
            "estimatedAvailableTime": "61560s"
        },
        "networkInfo": {
            "ip": "10.10.10.10",
            "wifiName": "TEST-WIFI"
        },
        "storageInfo": {
            "freeSpace": "9.47G",
            "totalSpace": "10.52G"
        },
        "onlineInfo": {
            "onlineTime": "2020-01-04 17:11:01",
            "lastOfflineTime": "2020-01-04 18:06:06",
            "lastOnlineTime": "2020-01-06 10:32:34",
            "state": 0,

        }
    }
}

异常示例

{
    "code": 400,
    "message": "机器人序列号为空"
}